/**
 * This file is part of 1genia trampoline
 * Copyright (C) 2007 1genia (contact@1genia.com)
 *
 * This library is free software; you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License as
 * published by the Free Software Foundation; version 3 of the License. 
 *
 * This library is distributed in the hope that it will be useful, but
 * WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * Library General Public License for more details. 
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with this library; see the file COPYING.TXT.  If not,
 * write to the Free Software Foundation, Inc., 51 Franklin Street,
 * Fifth Floor, Boston, MA 02110-1301, USA. 
 **/
package com.genia.toolbox.uml_generator.model;

import com.genia.toolbox.uml_generator.visitor.Visitable;

/**
 * the interface that represents an java Object.
 */
public interface AbstractJavaObject
    extends AbstractObject, Visitable
{

  /**
   * returns the name of the package of this object.
   * 
   * @return the name of the package of this object
   */
  public abstract String getPackageName();



  /**
   * setter for the packageName property.
   * 
   * @param packageName
   *          the packageName to set
   */
  public abstract void setPackageName(String packageName);



  /**
   * returns the qualified name of this object.
   * 
   * @return the qualified name of this object
   */
  public abstract String getQualifiedName();



  /**
   * returns the qualified name to use in the hibernate mapping file.
   * 
   * @return the qualified name to use in the hibernate mapping file
   */
  public abstract String getHibernateQualifiedName();



  /**
   * returns the default value of the object.
   * 
   * @return the default value of the object
   */
  public abstract String getDefaultValue();



  /**
   * return the object type that represents this type. For non primitive type,
   * it is always itself, for primitive type it is the correct wrapper.
   * 
   * @return the object type that represents this type
   */
  public abstract AbstractJavaObject getObject();



  /**
   * returns the original object if the current object is decorated.
   * 
   * @return the original object if the current object is decorated
   */
  public abstract AbstractJavaObject getUndecoraredObject();

}
